<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaMutex: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="multi-threading.html" title="Multi threading">
<link rel="prev" href="multi-threading.html" title="Multi threading">
<link rel="next" href="GdaLockable.html" title="GdaLockable">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgda-5.0-GdaMutex.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="multi-threading.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="multi-threading.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaLockable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgda-5.0-GdaMutex"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-5.0-GdaMutex.top_of_page"></a>GdaMutex</span></h2>
<p>GdaMutex — Recursive mutex implementation</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgda-5.0-GdaMutex.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaMutex.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="returnvalue">GdaMutex</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaMutex.html#gda-mutex-new" title="gda_mutex_new ()">gda_mutex_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaMutex.html#gda-mutex-lock" title="gda_mutex_lock ()">gda_mutex_lock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaMutex.html#gda-mutex-trylock" title="gda_mutex_trylock ()">gda_mutex_trylock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaMutex.html#gda-mutex-unlock" title="gda_mutex_unlock ()">gda_mutex_unlock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaMutex.html#gda-mutex-free" title="gda_mutex_free ()">gda_mutex_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaMutex.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex">GdaMutex</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaMutex.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;virtual/gda-ldap-connection.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaMutex.description"></a><h2>Description</h2>
<p><a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> implements a recursive mutex (unlike the <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="type">GMutex</span></a> implementation which offers no
guarantee about recursiveness). A recursive mutex is a mutex which can be locked several
times by the same thread (and needs to be unlocked the same number of times before
another thread can lock it).</p>
<p>A <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> can safely be used even in a non multi-threaded environment in which case
it does nothing.</p>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaMutex.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-mutex-new"></a><h3>gda_mutex_new ()</h3>
<pre class="programlisting"><a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="returnvalue">GdaMutex</span></a> *
gda_mutex_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">gda_mutex_new</code> has been deprecated since version 5.2.0 and should not be used in newly-written code.</p>
<p>use <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GRecMutex"><span class="type">GRecMutex</span></a> instead.</p>
</div>
<p>Creates a new <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a>.</p>
<div class="refsect3">
<a name="gda-mutex-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-mutex-lock"></a><h3>gda_mutex_lock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_mutex_lock (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> *mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">gda_mutex_lock</code> has been deprecated since version 5.2.0 and should not be used in newly-written code.</p>
<p>use <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GRecMutex"><span class="type">GRecMutex</span></a> instead.</p>
</div>
<p>Locks <em class="parameter"><code>mutex</code></em>
. If <em class="parameter"><code>mutex</code></em>
 is already locked by another thread, the current thread will block until <em class="parameter"><code>mutex</code></em>
 is unlocked by the other thread.</p>
<p>This function can be used even if <a href="/usr/share/gtk-doc/html/glib/glib-Deprecated-Thread-APIs.html#g-thread-init"><code class="function">g_thread_init()</code></a> has not yet been called, and, in that case, will do nothing.</p>
<p>Note: unlike <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-mutex-lock"><code class="function">g_mutex_lock()</code></a>, the <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> is recursive, which means a thread can lock it several times (and has
to unlock it as many times to actually unlock it).</p>
<div class="refsect3">
<a name="gda-mutex-lock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-mutex-trylock"></a><h3>gda_mutex_trylock ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_mutex_trylock (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> *mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">gda_mutex_trylock</code> has been deprecated since version 5.2.0 and should not be used in newly-written code.</p>
<p>use <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GRecMutex"><span class="type">GRecMutex</span></a> instead.</p>
</div>
<p>Tries to lock <em class="parameter"><code>mutex</code></em>
. If <em class="parameter"><code>mutex</code></em>
 is already locked by another thread, it immediately returns FALSE.
Otherwise it locks <em class="parameter"><code>mutex</code></em>
 and returns TRUE</p>
<p>This function can be used even if <a href="/usr/share/gtk-doc/html/glib/glib-Deprecated-Thread-APIs.html#g-thread-init"><code class="function">g_thread_init()</code></a> has not yet been called, and, in that case, will immediately return TRUE.</p>
<p>Note: Unlike <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-mutex-trylock"><code class="function">g_mutex_trylock()</code></a>, the <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> is recursive, which means a thread can lock it several times (and has
to unlock it as many times to actually unlock it)</p>
<div class="refsect3">
<a name="gda-mutex-trylock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-mutex-trylock.returns"></a><h4>Returns</h4>
<p> TRUE, if <em class="parameter"><code>mutex</code></em>
could be locked.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-mutex-unlock"></a><h3>gda_mutex_unlock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_mutex_unlock (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> *mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">gda_mutex_unlock</code> has been deprecated since version 5.2.0 and should not be used in newly-written code.</p>
<p>use <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GRecMutex"><span class="type">GRecMutex</span></a> instead.</p>
</div>
<p>Unlocks <em class="parameter"><code>mutex</code></em>
. If another thread is blocked in a <a class="link" href="libgda-5.0-GdaMutex.html#gda-mutex-lock" title="gda_mutex_lock ()"><code class="function">gda_mutex_lock()</code></a> call for <em class="parameter"><code>mutex</code></em>
, it wil
be woken and can lock <em class="parameter"><code>mutex</code></em>
 itself.
This function can be used even if <a href="/usr/share/gtk-doc/html/glib/glib-Deprecated-Thread-APIs.html#g-thread-init"><code class="function">g_thread_init()</code></a> has not yet been called, and, in that case, will do nothing.</p>
<div class="refsect3">
<a name="gda-mutex-unlock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-mutex-free"></a><h3>gda_mutex_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_mutex_free (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> *mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">gda_mutex_free</code> has been deprecated since version 5.2.0 and should not be used in newly-written code.</p>
<p>use <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GRecMutex"><span class="type">GRecMutex</span></a> instead.</p>
</div>
<p>Destroys <em class="parameter"><code>mutex</code></em>
.</p>
<div class="refsect3">
<a name="gda-mutex-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaMutex.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaMutex"></a><h3>GdaMutex</h3>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaMutex.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GdaLockable.html" title="GdaLockable"><span class="type">GdaLockable</span></a> and <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="type">GMutex</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>